home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / ab20 / ab20_archive / utilities / editors / diane-2.lha / DIAne.Doc < prev    next >
Text File  |  1992-02-17  |  15KB  |  322 lines

  1.                                    DIAne
  2.  
  3.                    Digital Intelligence Animation Editor
  4.  
  5.                       (C) Digital Intelligence MCMXCII
  6.                             All rights reserved
  7.  
  8.  
  9.     [1]    Introduction
  10.       [1.1] Installing DIAne
  11.       [1.2Starting DIAne
  12.  
  13.     [2]    The menus
  14.       [2.1] Project
  15.       [2.2] Edit
  16.       [2.3] Style
  17.       [2.4] Background
  18.       [2.5] Movement
  19.       [2.6] Extras
  20.  
  21.     [3]    Editing
  22.       [3.1] Slow/Fast mode
  23.       [3.2] Insert/Overstrike mode
  24.       [3.3] Cursor On/Off
  25.       [3.4] Deleting frames
  26.       [3.5] Changing the current frame
  27.       [3.6] Setting the speed of the animation
  28.  
  29.     [4]    Backgrounds
  30.       [4.1] Loading
  31.       [4.2] Saving
  32.  
  33.     [5]     The filerequester
  34.       [5.1] The layout
  35.       [5.2] Hidden and shown files
  36.       [5.3] Moving the cursor
  37.  
  38.     [6]    Registering
  39.  
  40. ---------------------------------------------------------------------------
  41.  
  42. [1] Introduction
  43.  
  44.     [1.1] Installing DIAne
  45.  
  46.     Installing  DIAne includes nothing more than copying the file DIAne
  47.     to  the  directory from which you want it to run.  Since DIAne runs
  48.     itself,  you will have no need to start the program using the 'run'
  49.     command.   Upon  running  DIAne  for the first time, a default file
  50.     will  be  created.   This  default  file  is  located  in  your  S:
  51.     directory  and updated every time you run the program, so make sure
  52.     that your startup disk is located in the drive.  This  default file
  53.     contains information about insert/overstrike mode and the colors of
  54.     the screen. This doesn't mean however that every time you alter the
  55.     default values  these changes will  be written to the default file.
  56.     If you want  to update the default file with your changes  you have
  57.     to use the 'Save defaults' option in the program.
  58.  
  59.     If you're familiar with my Ansi Editor DIEd (up to version 2.4) you
  60.     will  notice  that  the  layout  of the screen is much like that of
  61.     DIEd.  I've done this to make working with the two programs easier,
  62.     as well as to save me some time in programming.
  63.  
  64.     [1.2] Starting DIAne
  65.  
  66.     You  can  start DIAne either by typing just DIAne, or by giving two
  67.     optional  argument.   One  of the arguments must point to a file or
  68.     directory.   If  that  argument points to file DIAne will load that
  69.     file  upon  starting, if it is a directoryname, that directory will
  70.     be  taken  as your working directory (all filerequesters default to
  71.     that  directory).   If  no  directory was given then DIAne tries to
  72.     lock  the  directory  'DIAne:'  and  takes  that  as  it's  default
  73.     directory.  You can also start DIAne in the background by giving -B
  74.     as one of the two optional arguments.
  75.  
  76. [2] The menus
  77.  
  78.     [2.1] Project
  79.  
  80.     Under  the  project  menu  you  can load/save/view files as well as
  81.     giving  CLI  commands  and changing the current directory, clearing
  82.     the  file, and quitting DIAne.  As for the load/save/view commands,
  83.     I'll assume that these are so simple that they need no explaining.
  84.  
  85.     With the 'CLI command' option you can enter a CLI command which the
  86.     program  will  then  try  to  execute  using  the standard AmigaDOS
  87.     Execute()  call  which means that the program 'run' must be in your
  88.     C:   directory.   The command will redirect the output to the shell
  89.     from  which you've started DIAne, which may cause a problem if that
  90.     shell has been closed after starting DIAne.
  91.  
  92.     Change directory is used to set the working directory of DIAne.  By
  93.     default  the  directory  is  the  directory  given at startup time,
  94.     DIAne:   (if  assigned)  or  the  directory  from  which  DIAne was
  95.     started, in that order.
  96.  
  97.     [2.2] Edit
  98.  
  99.     Redraw  screen  redraws  the  complete animation, while redraw part
  100.     only draws that part of the animation till the current frame.  When
  101.     redrawing an animation there are two modes in which the program can
  102.     redraw,  fast  or  slow  mode.   These can't be set by the user but
  103.     depend  on  the  function  chosen.   Both  part-redraw  and  redraw
  104.     animation  will  redraw  the  animation  at it's current speed, all
  105.     other redrawing will be done at the highest possible speed.
  106.  
  107.     Toggle  insert  toggles  the  mode  (insert/overstrike), and remove
  108.     escape codes removes all styles and colors from the animation.
  109.  
  110.     [2.3] Style
  111.  
  112.     Editing the animation can be done in part by using this menu.  Here
  113.     you  can  set  the  style in which the animation must be printed as
  114.     well  as the background and foreground colors.  It depends on which
  115.     mode  you're using which action will be taken when you select a new
  116.     stlye or color (see [3.1] & [3.2]).
  117.  
  118.     [2.4] Background
  119.  
  120.     One thing that I've yet to see in any other animation editor is the
  121.     possibility  to  use  a  background  which  you can see through the
  122.     animation  you're  creating.   This  is particularly usefull if you
  123.     start  with  a  normal  CLI  screen from which you want to create a
  124.     non-standard  animation.   It  means  that  you  no  longer have to
  125.     calculate  all  position before trying to create the animation, you
  126.     can now see what you are doing and how the animation is supposed to
  127.     finish.   Hide and show background are there to allow you to remove
  128.     the  background for a moment to see just the animation.  One option
  129.     which  may seem rather obscure is the save background option.  Save
  130.     background  was  implemented  because  you can load animations as a
  131.     background  which will produce a normal CLI screen upon termination
  132.     which  you  had lost.  It may not seem particularly usefull, by try
  133.     it  by  loading  animations  as  backgrounds  and  saving  them  as
  134.     backgrounds.
  135.  
  136.     [2.5] Movement
  137.  
  138.     Moving  around  the  animtion is done by using the move menu or the
  139.     keyboard  itself.   The  keyboard shortcuts are defined in the menu
  140.     itself,  but  you  can  also  use the shifted cursor keys for these
  141.     functions.   Shift-left  moves one frame backwards, shift-right one
  142.     frame  forwards, shift-up is first frame and shift-down last frame.
  143.     First frame takes you to the first frame in the animation, omitting
  144.     the  rest  of  the  animation.   Last  frame  shows  you the entire
  145.     animation  and you can add to the animation.  Previous and next are
  146.     used  when you want to insert frames in the middle of the animation
  147.     (another original feature).
  148.  
  149.     [2.6] Extras
  150.  
  151.     The  extras  menu has all the things that have no real place in the
  152.     menus,  like  setting  the  colors,  saving  defaults,  setting the
  153.     savetimer and iconifying DIAne.
  154.  
  155.     When  you've  set the savetimer to another value than 0 the program
  156.     will  prompt  you with a requester when you've changed the file and
  157.     the  number of seconds you've entered as the savetimer have elapsed
  158.     without any saves.
  159.  
  160.     The only checkmarked option in the program is the hot-start option.
  161.     If  this  is  set  to  on,  quitting  DIAne will have the effect of
  162.     iconifying and you can recall the program when you want to (usefull
  163.     to  free  chip-mem  for  a  short  while).   You can still quit the
  164.     program  using  the  "Exit DIAne" option.  When you want to iconify
  165.     DIAne  without  hot-start  on  you  can do this by using the option
  166.     Iconify.
  167.  
  168. [3] Editing
  169.  
  170.     [3.1] Slow/Fast mode
  171.  
  172.     There  are  two  possible  editing modes.  Slow mode and Fast mode.
  173.     The  difference  between  these  two  modes will become apparent if
  174.     you're  in  overstrike  mode (in insert mode slow/fast mode changes
  175.     have  no  effect).   When you change the style of the animation and
  176.     the  mode  is set to slow, DIAne will redraw the animation from the
  177.     current  frame  in the new style.  If the mode is set to fast DIAne
  178.     will only redraw the current frame in it's new style.
  179.  
  180.     [3.2] Insert/Overstrike mode
  181.  
  182.     Insert  mode  is  used  when  you're  inserting new frames into the
  183.     animation,  while  overstrike  mode is used when you want to change
  184.     the  style  or  color  of existing frames.  When in insert mode the
  185.     program will add frames with a style normal (default) unless you've
  186.     changed  that style since starting the program.  Styles are toggled
  187.     using  the style menu, as well as the colors.  If you're editing in
  188.     overstrike  mode in the animation the style or color of the current
  189.     frame  and it's successors is changed, if you're in insert mode the
  190.     current  style  is  changed which will only be visible after adding
  191.     another frame.
  192.  
  193.     [3.3] Cursor On/Off
  194.  
  195.     The  cursor  on/off  option  isn't visible inside DIAne itself, but
  196.     it's use will soon become apparent if you type an animation outside
  197.     of  DIAne  (or view it) saved with the cursor off, or on.  When the
  198.     cursor  is  on  the  animation  will build much faster (because the
  199.     cursor doesn't have to be drawn with every character) which may not
  200.     always  be  what  you  want,  since the animation may be drawing to
  201.     fast.   Cursor  on will ensure that the cursor is on providing that
  202.     no other program has turned it off.
  203.  
  204.     [3.4] Deleting frames
  205.  
  206.     Deleting  frames  from  the  animation  can  only be done using the
  207.     backspace  key.   When your current frame is one you want to delete
  208.     just  type  a  backspace  and  the  frame  will be removed from the
  209.     animation.   To  get  the  frames you want to delete will take some
  210.     practice  but  won't  be  very difficult (I hope).  If you delete a
  211.     frame  the program checks to see if there is another frame which is
  212.     printed  at  the  same  position  at  the  lower  frame  number and
  213.     substitute that frame for the one you've deleted.  If it can't find
  214.     such  a  frame  the  background is checked for that position.  This
  215.     means  that you have a complete overview of how the animation looks
  216.     at the current frame.
  217.  
  218.     Don't  be  deceived  that you can delete a frame by positioning the
  219.     cursor  over the character you want deleted and pressing backspace.
  220.     This won't work, instead it will delete your current frame.
  221.  
  222.     [3.5] Changing the current frame
  223.  
  224.     You can cycle through the animation step by step using the movement
  225.     menu  or  the  keyboard shortcuts.  These also check the background
  226.     and  previous  frames  for  position  that  have  been cleared by a
  227.     previous  frame  operation.   When  using previous/next the current
  228.     frame is the frame that your cursor is positioned on (see [2.5]).
  229.  
  230.     [3.6] Setting the speed of the animation
  231.  
  232.     You  can  set  the  speed of the animation by selecting "Set speed"
  233.     from  the  edit  menu.   This will prompt you for a value from 0 to
  234.     255,  0  being  the  fastest speed and 255 being the slowest.  When
  235.     saving  the  file  the  editor will put ESC-[s sequences after each
  236.     character  so  that  the  output  is slowed down.  When reading the
  237.     animation  back  however, the speed will not be read back by DIAne,
  238.     so you get the screen back at the speed at which you loaded it.
  239.  
  240. [4] Backgrounds
  241.  
  242.     [4.1] Loading
  243.  
  244.     When  selecting a background you have no need to choose from merely
  245.     simple  CLI screens, you can also use an animation as a background.
  246.     The  program  will  read  the animation and every character will be
  247.     placed  into  the  correct  frame.   This means that the background
  248.     will look like the animation when it has finished.
  249.  
  250.     [4.2] Saving
  251.  
  252.     As  I mentioned before saving a background may not seem like a very
  253.     usefull  option,  but I've found that I sometimes have a use for an
  254.     animation  when  I've  already  thrown  the  background out, or I'm
  255.     editing a new animation over an old one and I don't want to use the
  256.     old animation as a background every time since loading an animation
  257.     as  loading  a  background is more time consuming than a CLI screen
  258.     itself.
  259.  
  260.     The output from this function is not optimized, it seemed that this
  261.     was not a very simple operation so the output may be some 6K when a
  262.     file of 1K would suffice.
  263.  
  264. [5] The filerequester
  265.  
  266.     [5.1] The layout
  267.  
  268.     When  you  start  the  filerequester  by requesting load/save of an
  269.     animation  or  of  a  background  you are prompted with a requester
  270.     which  consists  of  three different parts.  The three boxes at the
  271.     top  of  the window are used for the output of assigns, directories
  272.     and  files.   The  part  of  the  window  below  that  is  used for
  273.     (character) input, and the bottom of the window is reserved for the
  274.     gadgets.   Of  the  three  boxes,  the  top-right  one  is used for
  275.     assigns,  the  top-left one for directories and the largest one for
  276.     the files.
  277.  
  278.     [5.2] Hidden and shown files
  279.  
  280.     You  can  select  which  files you want to show or to hide.  A file
  281.     will  only  be  shown if it doesn't match any of the hide masks and
  282.     does  match one of the show masks.  Using a field seperator (|) you
  283.     can  input  the  seperate  masks, i.e.  "*.c|*.h" in the show field
  284.     would  shown  all  the files ending on .c or .h.  The program works
  285.     with the one (*) wildcard which stands for any number of characters
  286.     (0 or more).
  287.  
  288.     [5.3] Moving the cursor
  289.  
  290.     You can move the cursor by pressing SHIFT-RETURN or ALT-RETURN when
  291.     any  of  the  string gadgets is active.  A shifted return will move
  292.     the cursor in a vertical direction (i.e.  from the directory gadget
  293.     to  the  file gadget), using alt and return you can move the cursor
  294.     in  a  horizontal  direction.  A normal return in any of the fields
  295.     other  than  the  file field will result in the cursor returning to
  296.     the  file  field.  Pressing return in the file field will close the
  297.     requester.
  298.  
  299. [6Registering
  300.  
  301.     This  program  is  shareware,  so  if you like and use the program,
  302.     please  support this principle.  I've spent quite a lot of time and
  303.     effort  on  this  program.  When you've registered you will receive
  304.     the next (shareware) version of the program when available.
  305.  
  306.     To register please send your name, address, preference as to how to
  307.     receive the update (normal mail/e-mail), ideas for improvements, as
  308.     well as an international money order, foreign cash (preferably US$,
  309.     English   pounds   or   some  other,  strong,  currency)  or  Dutch
  310.     cash/cheques for approximatly 20$ to the following address:
  311.  
  312.     P-E Raue
  313.     Bieslook 92
  314.     1422 RS Uithoorn
  315.     The Netherlands
  316.  
  317.     If you want to contact me using E-Mail you can sent messages to:
  318.  
  319.     peraue@cs.vu.nl
  320.  
  321.     until 1993/1994.    
  322.